home *** CD-ROM | disk | FTP | other *** search
/ The Atari Compendium / The Atari Compendium (Toad Computers) (1994).iso / files / umich / utils / abe.arc / README < prev    next >
Encoding:
Text File  |  1989-06-22  |  9.0 KB  |  241 lines
  1.  
  2.          ABE Ascii-Binary Encoding System (Brad Templeton 1989)
  3.  
  4.                      (abe/dabe/tinydabe)
  5.  
  6. ---ABE:[gemdos][version 1000][890616][AR]------------------------------------
  7.  
  8.     This is the GEMDOS [ATARI.ST] variant of the recently posted 
  9.     [890604] ABE Encoder/Decoder of Brad Templeton. 
  10.  
  11.     The original code was clean enough to allow a straightforward 
  12.     porting to the ATARI.ST machines, using either the MW C or 
  13.     the [pd] SOZOBON C compiler. MW C generates less code than
  14.     SOZOBON C, but its C-library is not fully compatible with
  15.     the UNIX Clib [BSD4.x, SUN 3.x].
  16.  
  17.     The obvious solution was to replace the faulty items (as, for 
  18.     instance, scanf(), sscanf(), etc.) by [dLib 1.2]-analogues, 
  19.     written by Dale Schumacher (1988). The latter Clib is [pd]. 
  20.  
  21.         The [gemdos] version has some new features, intended to support
  22.     a direct desk-top manipulation of the main encoder/decoder (no 
  23.     Bourne-like shell needed). However, tinydabe needs a shell.
  24.         The [gemdos] idiosyncrasies are documented below (but NOT in 
  25.     the manuals).
  26.  
  27.     As specified by the author, the sources are copyrighted. The 
  28.     tiny decoders [source + binaries] are in the public domain and 
  29.     so is the [gemdos] version of the binaries, herewith included.
  30.  
  31.     If it turns out that there is a larger interest in the ABE-style 
  32.     encoding/decoding, I will eventually produce also a Macintosh 
  33.     analogue of the package (intended to work as a substitute for 
  34.     BinHex & Co., FULLY PORTABLE ACROSS different OSs).
  35.  
  36.     For further information, support, bug-reports, contact please 
  37.     the [original] author, not me. [AR].
  38.  
  39. ---[Copyright info:][BT]-----------------------------------------------------
  40.  
  41.    [This package] is Copyright 1989 by Brad Templeton.  I hereby grant 
  42.    a licence for unlimited use of binaries generated by compiling this 
  43.    source code.  
  44.    
  45.    The source code may be distributed and modified for non-commercial 
  46.    purposes, but all copyright messages must be retained.  
  47.  
  48.    Changes which alter the file format of ABE files are not permitted 
  49.    without the explicit consent of Brad Templeton.  I mean it.
  50.  
  51.    No fee is required for the use of the program(s). See the MAN page(s) 
  52.    for more details.
  53.  
  54.    Changes which move these programs to other machines and operating
  55.    systems are encouraged. (Fine! [AR].)  
  56.  
  57.    Please send any port to a new machine to me at abe@looking.UUCP. [BT].
  58.  
  59. ---[Disclaimer:][AR]---------------------------------------------------------
  60.  
  61.     "We make no warranty with respect to the contents of this document,
  62.     of the appended manuals, or of the software they describe, and 
  63.     disclaim any explicit and/or implied suggestions of usefulness 
  64.     for any particular purpose. 
  65.  
  66.     Use of the described software presupposes the fact that the user 
  67.     is willing to assume all risks, and/or damages, if any, arising 
  68.     as a result, even if this is caused by negligence, ignorance or
  69.     some other fault." [AR].      
  70.  
  71. ---[General info:][AR]-------------------------------------------------------
  72.  
  73. SOURCES [unix][msdos][gemdos]:
  74.  
  75.     AUTHOR: brad@looking.on.ca (Brad Templeton)
  76.     UNIX/MSDOS [originals] posted to:
  77.         Newsgroups: comp.sources.misc 
  78.         Reference: [Volume 7, Issues 1-2] = [v07i001/002]
  79.         Moderator: allbery@uunet.UU.NET (Brandon S. Allbery)
  80.         Subject: ABE bullet-proof ascii encoder
  81.         Date: 4 Jun 89 [01:07:26 GMT][01:07:41 GMT]
  82.         Submitted-by: brad@looking.on.ca (Brad Templeton)
  83.         Archive-name: abe/part01, abe/part02
  84.     CURRENT VERSION: [1000]
  85.  
  86.         CONTENTS [SOURCES]:
  87.     - Makefile
  88.     - abe.h
  89.     - abe.c
  90.     - dabe.c
  91.     - tinydabe.c [2 versions: tdABE1.c, tdABE2.c]
  92.     NOTA BENE: Only tinydabe is in the public domain.
  93.     CONTENTS [DOCUMENTATION]:
  94.         - read.me
  95.         - [nroff -man]: abe.1, dabe.1
  96.         - abeformat.        
  97.  
  98. ---[Here is a copy of the original READ.ME as posted by the author:]---------
  99.  
  100.     ABE Ascii-Binary Encoding System by B. Templeton
  101.  
  102. ABE is a replacement for uuencode/uudecode designed to deal with all the 
  103. typical problems of USENET transmission, along with those of other media.
  104.  
  105. Advantages are:
  106.  
  107.     Files are often smaller, and compress well.
  108.  
  109.     All printable characters map to themselves, so strings in
  110.     binaries are readable right in the encoding.
  111.  
  112.     All lines are indexed, so sort(1) can repair any random
  113.     scrambling of lines or files. (This can be turned off.)
  114.  
  115.     Extraneous lines (news headers, comments, signatures etc.) are
  116.     ignored, even in the middle of encodings.
  117.  
  118.     A PD tiny decoder is available to include with files for first
  119.     time users.
  120.  
  121.     Files can be split up automatically into equal sized blocks.
  122.  
  123.     Blocks can contain redundant information so that the decoder
  124.     can handle blocks in any order, even with reposted duplicates
  125.     and extraneous articles.
  126.  
  127.     Files with blank regions can be constructed from multi-part 
  128.     encodings with damaged blocks.
  129.  
  130.     Multiple files can be placed in one encoding.
  131.  
  132.     The decoder is extremely general and configurable, and supports 
  133.     many features not currently found in the encoder, but which other 
  134.     encoder writers might fight useful.
  135.  
  136. In general, a redundant ABE encoding posted to a typical newsgroup over 
  137. a certain article region can be decoded with something as simple as:
  138.     
  139.         dabe /usr/spool/news/comp/binaries/group/3[45]?
  140.  
  141. Where it doesn't matter much if there are postings in a random order,
  142. duplicate postings, or inserted articles on other topics.   Ie. exactly
  143. all the things that are a pain about usenet (or mail) binaries.
  144. (You can usually run dabe right on your entire mailbox.)
  145.  
  146. The ABE encoder (and decoder) support 3 different encoding formats.  One
  147. uses all 94 printable ASCII characters, the other avoids characters that
  148. have trouble in ASCII-EBCDIC translations, and the 3rd is the UUENCODE
  149. format.  (ABE can make files decodable by a typical uudecode program.)
  150.  
  151. ---[AR: Info for the recipients of the comp.sources.misc archive:]---
  152.  
  153. To build, unpack these files in a directory.  Move the tiny decoders, 
  154. td*, to some official place, and edit the Makefile to indicate where 
  155. you put it.  (Example, /usr/lib/td%s.)   Check the Makefile and defines 
  156. file (abe.h) for any system dependencies, then make.
  157.  
  158. Install the resulting abe and dabe programs in some bin directory.  
  159. Install abe.1 and dabe.1 in appropriate man directories.  Leave the file 
  160. format description around for people to read it.  (Possibly modify abe.1 
  161. [= abe.man, AR] to indicate where the file format file is, and where the 
  162. tiny decoders are.)
  163.  
  164. The main portability concern involves my use of arbitary args to fprintf 
  165. in the various warning and error message routines in abe.c and dabe.c.  
  166. Watch for these. [BT].
  167.  
  168. ---[end of READ.ME file]-----------------------------------------------------
  169.  
  170. ---[GEMDOS-ABE info:][AR]----------------------------------------------------
  171.  
  172.         GEMDOS-ABE: ATARI.ST DISTRIBUTION [AR][890616]:
  173.  
  174.         CURRENT VERSION [gemdos][1000] for ATARI.ST    
  175.     SOURCES [unix][msdos][gemdos][etcaetera]:
  176.     - tdabe1.c [ASCII-ONLY version]
  177.     - tdabe2.c [EBCDIC version]
  178.     BINARIES [gemdos]:
  179.     - abe.ttp
  180.     - dabe.ttp
  181.     - tdabe1.prg  [= tinydabe for ASCII-ONLY format]
  182.     - tdabe2.prg  [= tinydabe for EBCDIC format]
  183.     DOCUMENTATION:
  184.     - readme      [= this file]
  185.     - abe.man     [= formatted abe.1]
  186.     - dabe.man    [= formatted dabe.1]
  187.     - abe_fmt.doc [= abeformat]
  188.         CC INFO: This [gemdos] version has been obtained with:
  189.     - MW C 3.0.5 (Mark Williams Comp. 1988) and 
  190.     - dLibs 1.2 ([pd], by Dale Schumacher 1988).
  191.  
  192. GEMDOS [ATARI.ST] IDIOSYNCRASIES:
  193.  
  194.         (0) READ THIS, TOO: the *.man's are NOT updated for [gemdos]!
  195.  
  196.     (1) Both abe.ttp and dabe.ttp admit of UPPERCASE options
  197.         (intended for desk-top only use).
  198.  
  199.     (2) New feature: abe.ttp admits of a new option
  200.  
  201.             output=<path-name>
  202.  
  203.         This sends the encoded output to <path-name> instead of
  204.         stdout. Useful for desk-top only usage and/or (some kind
  205.         of) batch processing.
  206.  
  207.             Example: with 
  208.  
  209.             [abe.ttp] o=abe_src.abe \src\abe\* 
  210.  
  211.         we make an abe-encoded archive abe_src.abe of the contents 
  212.         of the {current-drive:}\src\abe-folder. As specified in 
  213.         abe.man, only the first letter of an option is significant. 
  214.         To de-code this back we must do 
  215.         
  216.             [dabe.ttp] abe_src.abe.
  217.  
  218.             Similarly, with
  219.  
  220.             [abe.ttp] o=tdabe.abe -n +u tdabe1.prg
  221.  
  222.         we make an abe-encoding tdabe.abe (containing tdabe1.prg
  223.         only) that can be also de-coded with
  224.  
  225.             [uudecode] tdabe.abe 
  226.  
  227.         on UNIX/MSDOS/ATARI.ST. (For ATARI.STs there is also a  
  228.         clever uudecoder [uud.ttp], operating like [uudecode], 
  229.          that is also able to cope with multi-file encodings.)
  230.  
  231.     (3) The current [gemdos] version of dabe.ttp updates decodings;
  232.         that is: it does NOT restore the original date-time stamps
  233.         of the abe-encoded files.
  234.  
  235.     (4) Note that tdabe[1-2].prg would need a Bourne-like shell to 
  236.         work. Try, for instance, gulam ([pd], by Prabhaker Mateti), 
  237.         or msh (Mark Williams Comp.) or the GP-Shell/Craft of Gert 
  238.         Poletiek (ComMedia, Amsterdam).
  239.  
  240. ---[AR]=[Adrian Rezus]=[adriaan@wn2.sci.kun.nl]:[890616]---------------------
  241.